package com.kim.store.mapper;

import com.kim.store.entity.User;
import org.apache.ibatis.annotations.Param;

import java.util.Date;

/**
 * 用户模块的持久层接口
 * 作用：
 * (1)用户注册，首先用户注册时先使用 findByUsername()方法来判断用户名是否被注册
 *  其次是使用insert()方法来注册账号密码
 * (2)用户登录：根据用户提交的用户名和密码，首先通过findByUsername()方法查询用户名是否存在，
 *  其次密码的查询是放到了业务层执行
 */

public interface UserMapper {
    /**
     * 插入用户的数据
     * @param user 用户的数据
     * @return 受影响的行数（增删改都有受影响的行数作为返回值，可以根据受影响的返回值判断是否执行）
     */
    Integer insert(User user);

    /**
     * 根据用户名来查询用户的数据
     * @param username 用户名
     * @return 如果找到对应的用户则返回这个用户的数据，找不到则返回null
     */
    User findByUsername(String username);

    /**
     * 根据用户的uid来修改用户密码
     * @param uid 用户id
     * @param password 用户输入的新密码
     * @param modifiedUser 表示修改的执行者
     * @param modifiedTime 表示修改的时间
     * @return 返回值为受影响的行数
     */
    Integer updatePasswordByUid(Integer uid,
                                String password,
                                String modifiedUser,
                                Date modifiedTime);

    /**
     * 根据用户的id查询用户的数据
     * @param uid 用户id
     * @return 如果找到了则返回对象，否则返回null
     */
    User findByUid(Integer uid);

    /**
     * 更新用户的数据信息
     * @param user 用户的数据
     * @return 返回值为受到影响的行数
     */
    Integer updateInfoByUid(User user);

    /**
     * @Param("SQL映射文件中#{}占位符的变量名")：解决的问题是当SQL语句的占位符和映射的接口
     * 方法参数名不一致时，需要将某个参数强行注入到某个占位符变量上时，可以使用@Param来标注
     * 映射的关系
     *
     * 根据用户uid值来修改用户的头像
     * @param uid
     * @param avatar
     * @param modifiedUser
     * @param modifiedTime
     * @return
     */
//如果占位符的名称和参数名称不一致时就用到了@Param(),把参数列表中的uid注入到占位符sql语句的uid
    Integer updateAvatarByUid (@Param("uid") Integer uid,
                              String avatar,
                              String modifiedUser,
                              Date modifiedTime);
}
